home *** CD-ROM | disk | FTP | other *** search
/***************************************************************************** * vlc_video.h: common video definitions ***************************************************************************** * Copyright (C) 1999 - 2008 the VideoLAN team * $Id: e739d93611b9fa43335963ba4735d2a6a0126fb3 $ * * Authors: Vincent Seguin <seguin@via.ecp.fr> * Samuel Hocevar <sam@via.ecp.fr> * Olivier Aubert <oaubert 47 videolan d07 org> * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA. *****************************************************************************/ #ifndef VLC_VOUT_H_ #define VLC_VOUT_H_ 1 /** * \file * This file defines common video output structures and functions in vlc */ #include <vlc_picture.h> #include <vlc_filter.h> #include <vlc_subpicture.h> /** * Video picture heap, either render (to store pictures used * by the decoder) or output (to store pictures displayed by the vout plugin) */ struct picture_heap_t { int i_pictures; /**< current heap size */ /* \name Picture static properties * Those properties are fixed at initialization and should NOT be modified * @{ */ unsigned int i_width; /**< picture width */ unsigned int i_height; /**< picture height */ vlc_fourcc_t i_chroma; /**< picture chroma */ unsigned int i_aspect; /**< aspect ratio */ /**@}*/ /* Real pictures */ picture_t* pp_picture[VOUT_MAX_PICTURES]; /**< pictures */ int i_last_used_pic; /**< last used pic in heap */ bool b_allow_modify_pics; /* Stuff used for truecolor RGB planes */ uint32_t i_rmask; int i_rrshift, i_lrshift; uint32_t i_gmask; int i_rgshift, i_lgshift; uint32_t i_bmask; int i_rbshift, i_lbshift; /** Stuff used for palettized RGB planes */ void (* pf_setpalette) ( vout_thread_t *, uint16_t *, uint16_t *, uint16_t * ); }; /***************************************************************************** * Prototypes *****************************************************************************/ /** * Initialise different fields of a picture_t and allocates the picture buffer. * \param p_this a vlc object * \param p_pic pointer to the picture structure. * \param i_chroma the wanted chroma for the picture. * \param i_width the wanted width for the picture. * \param i_height the wanted height for the picture. * \param i_aspect the wanted aspect ratio for the picture. */ VLC_EXPORT( int, vout_AllocatePicture,( vlc_object_t *p_this, picture_t *p_pic, uint32_t i_chroma, int i_width, int i_height, int i_sar_num, int i_sar_den ) ); #define vout_AllocatePicture(a,b,c,d,e,f,g) \ vout_AllocatePicture(VLC_OBJECT(a),b,c,d,e,f,g) /** * \defgroup video_output Video Output * This module describes the programming interface for video output threads. * It includes functions allowing to open a new thread, send pictures to a * thread, and destroy a previously opened video output thread. * @{ */ /** * Video ouput thread private structure */ typedef struct vout_thread_sys_t vout_thread_sys_t; /** * Video output thread descriptor * * Any independent video output device, such as an X11 window or a GGI device, * is represented by a video output thread, and described using the following * structure. */ struct vout_thread_t { VLC_COMMON_MEMBERS bool b_error; /** \name Thread properties and locks */ /**@{*/ vlc_mutex_t picture_lock; /**< picture heap lock */ vlc_mutex_t change_lock; /**< thread change lock */ vout_sys_t * p_sys; /**< system output method */ /**@}*/ /** \name Current display properties */ /**@{*/ uint16_t i_changes; /**< changes made to the thread. \see \ref vout_changes */ unsigned b_fullscreen:1; /**< toogle fullscreen display */ unsigned b_autoscale:1; /**< auto scaling picture or not */ unsigned b_on_top:1; /**< stay always on top of other windows */ int i_zoom; /**< scaling factor if no auto */ unsigned int i_window_width; /**< video window width */ unsigned int i_window_height; /**< video window height */ unsigned int i_alignment; /**< video alignment in window */ /**@}*/ /** \name Plugin used and shortcuts to access its capabilities */ /**@{*/ module_t * p_module; int ( *pf_init ) ( vout_thread_t * ); void ( *pf_end ) ( vout_thread_t * ); int ( *pf_manage ) ( vout_thread_t * ); void ( *pf_render ) ( vout_thread_t *, picture_t * ); void ( *pf_display ) ( vout_thread_t *, picture_t * ); void ( *pf_swap ) ( vout_thread_t * ); /* OpenGL only */ int ( *pf_lock ) ( vout_thread_t * ); /* OpenGL only */ void ( *pf_unlock ) ( vout_thread_t * ); /* OpenGL only */ int ( *pf_control ) ( vout_thread_t *, int, va_list ); /**@}*/ /** \name Video heap and translation tables */ /**@{*/ int i_heap_size; /**< heap size */ picture_heap_t render; /**< rendered pictures */ picture_heap_t output; /**< direct buffers */ video_format_t fmt_render; /* render format (from the decoder) */ video_format_t fmt_in; /* input (modified render) format */ video_format_t fmt_out; /* output format (for the video output) */ /**@}*/ /* Picture heap */ picture_t p_picture[2*VOUT_MAX_PICTURES+1]; /**< pictures */ /* Subpicture unit */ spu_t *p_spu; /* Video output configuration */ config_chain_t *p_cfg; /* Private vout_thread data */ vout_thread_sys_t *p; }; #define I_OUTPUTPICTURES p_vout->output.i_pictures #define PP_OUTPUTPICTURE p_vout->output.pp_picture #define I_RENDERPICTURES p_vout->render.i_pictures #define PP_RENDERPICTURE p_vout->render.pp_picture /** \defgroup vout_changes Flags for changes * These flags are set in the vout_thread_t::i_changes field when another * thread changed a variable * @{ */ /** b_info changed */ #define VOUT_INFO_CHANGE 0x0001 /** b_interface changed */ #define VOUT_INTF_CHANGE 0x0004 /** b_autoscale changed */ #define VOUT_SCALE_CHANGE 0x0008 /** b_on_top changed */ #define VOUT_ON_TOP_CHANGE 0x0010 /** b_cursor changed */ #define VOUT_CURSOR_CHANGE 0x0020 /** b_fullscreen changed */ #define VOUT_FULLSCREEN_CHANGE 0x0040 /** i_zoom changed */ #define VOUT_ZOOM_CHANGE 0x0080 /** size changed */ #define VOUT_SIZE_CHANGE 0x0200 /** depth changed */ #define VOUT_DEPTH_CHANGE 0x0400 /** change chroma tables */ #define VOUT_CHROMA_CHANGE 0x0800 /** cropping parameters changed */ #define VOUT_CROP_CHANGE 0x1000 /** aspect ratio changed */ #define VOUT_ASPECT_CHANGE 0x2000 /** change/recreate picture buffers */ #define VOUT_PICTURE_BUFFERS_CHANGE 0x4000 /**@}*/ /* Alignment flags */ #define VOUT_ALIGN_LEFT 0x0001 #define VOUT_ALIGN_RIGHT 0x0002 #define VOUT_ALIGN_HMASK 0x0003 #define VOUT_ALIGN_TOP 0x0004 #define VOUT_ALIGN_BOTTOM 0x0008 #define VOUT_ALIGN_VMASK 0x000C #define MAX_JITTER_SAMPLES 20 /* scaling factor (applied to i_zoom in vout_thread_t) */ #define ZOOM_FP_FACTOR 1000 /***************************************************************************** * Prototypes *****************************************************************************/ /** * This function will * - returns a suitable vout (if requested by a non NULL p_fmt) * - recycles an old vout (if given) by either destroying it or by saving it * for latter usage. * * The purpose of this function is to avoid unnecessary creation/destruction of * vout (and to allow optional vout reusing). * * You can call vout_Request on a vout created by vout_Create or by a previous * call to vout_Request. * You can release the returned value either by vout_Request or vout_Close() * followed by a vlc_object_release() or shorter vout_CloseAndRelease() * * \param p_this a vlc object * \param p_vout a vout candidate * \param p_fmt the video format requested or NULL * \return a vout if p_fmt is non NULL and the request is successfull, NULL * otherwise */ VLC_EXPORT( vout_thread_t *, vout_Request, ( vlc_object_t *p_this, vout_thread_t *p_vout, video_format_t *p_fmt ) ); #define vout_Request(a,b,c) vout_Request(VLC_OBJECT(a),b,c) /** * This function will create a suitable vout for a given p_fmt. It will never * reuse an already existing unused vout. * * You have to call either vout_Close or vout_Request on the returned value * \param p_this a vlc object to which the returned vout will be attached * \param p_fmt the video format requested * \return a vout if the request is successfull, NULL otherwise */ VLC_EXPORT( vout_thread_t *, vout_Create, ( vlc_object_t *p_this, video_format_t *p_fmt ) ); #define vout_Create(a,b) vout_Create(VLC_OBJECT(a),b) /** * This function will close a vout created by vout_Create or vout_Request. * The associated vout module is closed. * Note: It is not released yet, you'll have to call vlc_object_release() * or use the convenient vout_CloseAndRelease(). * * \param p_vout the vout to close */ VLC_EXPORT( void, vout_Close, ( vout_thread_t *p_vout ) ); /** * This function will close a vout created by vout_Create * and then release it. * * \param p_vout the vout to close and release */ static inline void vout_CloseAndRelease( vout_thread_t *p_vout ) { vout_Close( p_vout ); vlc_object_release( p_vout ); } /** * This function will handle a snapshot request. * * pp_image, pp_picture and p_fmt can be NULL otherwise they will be * set with returned value in case of success. * * pp_image will hold an encoded picture in psz_format format. * * i_timeout specifies the time the function will wait for a snapshot to be * available. * */ VLC_EXPORT( int, vout_GetSnapshot, ( vout_thread_t *p_vout, block_t **pp_image, picture_t **pp_picture, video_format_t *p_fmt, const char *psz_format, mtime_t i_timeout ) ); /* */ VLC_EXPORT( int, vout_ChromaCmp, ( uint32_t, uint32_t ) ); VLC_EXPORT( picture_t *, vout_CreatePicture, ( vout_thread_t *, bool, bool, unsigned int ) ); VLC_EXPORT( void, vout_DestroyPicture, ( vout_thread_t *, picture_t * ) ); VLC_EXPORT( void, vout_DisplayPicture, ( vout_thread_t *, picture_t * ) ); VLC_EXPORT( void, vout_LinkPicture, ( vout_thread_t *, picture_t * ) ); VLC_EXPORT( void, vout_UnlinkPicture, ( vout_thread_t *, picture_t * ) ); VLC_EXPORT( void, vout_PlacePicture, ( const vout_thread_t *, unsigned int, unsigned int, unsigned int *, unsigned int *, unsigned int *, unsigned int * ) ); /** * Return the spu_t object associated to a vout_thread_t. * * The return object is valid only as long as the vout is. You must not * release the spu_t object returned. * It cannot return NULL so no need to check. */ VLC_EXPORT( spu_t *, vout_GetSpu, ( vout_thread_t * ) ); void vout_IntfInit( vout_thread_t * ); VLC_EXPORT( void, vout_EnableFilter, ( vout_thread_t *, const char *,bool , bool ) ); static inline int vout_vaControl( vout_thread_t *p_vout, int i_query, va_list args ) { if( p_vout->pf_control ) return p_vout->pf_control( p_vout, i_query, args ); else return VLC_EGENERIC; } static inline int vout_Control( vout_thread_t *p_vout, int i_query, ... ) { va_list args; int i_result; va_start( args, i_query ); i_result = vout_vaControl( p_vout, i_query, args ); va_end( args ); return i_result; } enum output_query_e { VOUT_SET_STAY_ON_TOP=1, /* arg1= bool res= */ VOUT_SET_VIEWPORT, /* arg1= view rect, arg2=clip rect, res= */ VOUT_REDRAW_RECT, /* arg1= area rect, res= */ }; /**@}*/ #endif /* _VLC_VIDEO_H */ 
